Skip to content

[admin] Convert @throws to normal description text #391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2025
Merged

Conversation

AlexJerabek
Copy link
Collaborator

The @throws TSDoc isn't handled properly by the API Extractor/Documenter chain. This PR adds some text conversion to the preprocessor to keep the information in the docs.

@AlexJerabek AlexJerabek requested a review from alison-mk August 7, 2025 22:01
Copy link

Learn Build status updates of commit 427dc5e:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/officescript.yml ✅Succeeded View (office-scripts)
generate-docs/api-extractor-inputs-officescript/officescript.d.ts ✅Succeeded
generate-docs/scripts/preprocessor.ts ✅Succeeded

For more details, please refer to the build report.

Copy link
Contributor

@alison-mk alison-mk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!

@AlexJerabek AlexJerabek merged commit 0777df3 into main Aug 11, 2025
2 checks passed
@AlexJerabek AlexJerabek deleted the AlexJ-Throws branch August 11, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants